home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / apt-xapian-index / plugins / sections.py < prev    next >
Text File  |  2008-08-20  |  3KB  |  87 lines
  1. import apt
  2. import xapian
  3. import os, os.path
  4.  
  5. class Sections:
  6.     def info(self):
  7.         """
  8.         Return general information about the plugin.
  9.  
  10.         The information returned is a dict with various keywords:
  11.          
  12.          timestamp (required)
  13.            the last modified timestamp of this data source.  This will be used
  14.            to see if we need to update the database or not.  A timestamp of 0
  15.            means that this data source is either missing or always up to date.
  16.          values (optional)
  17.            an array of dicts { name: name, desc: description }, one for every
  18.            numeric value indexed by this data source.
  19.  
  20.         Note that this method can be called before init.  The idea is that, if
  21.         the timestamp shows that this plugin is currently not needed, then the
  22.         long initialisation can just be skipped.
  23.         """
  24.         file = apt.apt_pkg.Config.FindFile("Dir::Cache::pkgcache")
  25.         return dict(timestamp = os.path.getmtime(file))
  26.  
  27.     def init(self, info, progress):
  28.         """
  29.         If needed, perform long initialisation tasks here.
  30.  
  31.         info is a dictionary with useful information.  Currently it contains
  32.         the following values:
  33.  
  34.           "values": a dict mapping index mnemonics to index numbers
  35.  
  36.         The progress indicator can be used to report progress.
  37.         """
  38.         pass
  39.  
  40.     def doc(self):
  41.         """
  42.         Return documentation information for this data source.
  43.  
  44.         The documentation information is a dictionary with these keys:
  45.           name: the name for this data source
  46.           shortDesc: a short description
  47.           fullDoc: the full description as a chapter in ReST format
  48.         """
  49.         return dict(
  50.             name = "Package sections",
  51.             shortDesc = "Debian package sections",
  52.             fullDoc = """
  53.             The section is indexed literally, with the prefix XS.
  54.             """
  55.         )
  56.  
  57.     def index(self, document, pkg):
  58.         """
  59.         Update the document with the information from this data source.
  60.  
  61.         document  is the document to update
  62.         pkg       is the python-apt Package object for this package
  63.         """
  64.         sec = pkg.section
  65.         if sec:
  66.             document.add_term("XS"+sec)
  67.  
  68.     def indexDeb822(self, document, pkg):
  69.         """
  70.         Update the document with the information from this data source.
  71.  
  72.         This is alternative to index, and it is used when indexing with package
  73.         data taken from a custom Packages file.
  74.  
  75.         document  is the document to update
  76.         pkg       is the Deb822 object for this package
  77.         """
  78.         sec = pkg["Section"]
  79.         if sec:
  80.             document.add_term("XS"+sec)
  81.  
  82. def init():
  83.     """
  84.     Create and return the plugin object.
  85.     """
  86.     return Sections()
  87.